reworded push_in description with Owen's help, fixes bug #482034.

2007-10-01 20:21:28  Tim Janik  <timj@imendio.com>

        * gtk/tmpl/gtkmenu.sgml: reworded push_in description with Owen's
        help, fixes bug #482034.

svn path=/trunk/; revision=18872

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 281b1edf9c2b0973a8b6e42950f9f6000efb9e1e..c8dc45737611575301366eab95e7360b919255b1 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2007-10-01 20:21:28  Tim Janik  <timj@imendio.com>
+
+       * gtk/tmpl/gtkmenu.sgml: reworded push_in description with Owen's
+       help, fixes bug #482034.
+
 2007-09-13  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.12.0 ===

diff --git a/docs/reference/gtk/tmpl/gtkmenu.sgml b/docs/reference/gtk/tmpl/gtkmenu.sgml
index 18f7fec9d1fb2020730ba3168481831a514eb8fa..7fde58e5792a3f14015d98d6c16d3ff30ef4950a 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkmenu.sgml
+++ b/docs/reference/gtk/tmpl/gtkmenu.sgml
@@ -394,8 +394,16 @@ and @y parameters to the coordinates where the menu is to be drawn.
 menu shall be drawn.  This is an output parameter.
 @y: address of the #gint representing the vertical position where the
 menu shall be drawn.  This is an output parameter.
-@push_in: whether the first menu item should be offset (pushed in) to be
-          aligned with the menu popup position (only useful for GtkOptionMenu).
+@push_in: This parameter controls how menus placed outside the monitor are handled.
+        If this is set to TRUE and part of the menu is outside the monitor then
+        GTK+ pushes the window into the visible area, effectively modifying the
+        popup position.
+        Note that moving and possibly resizing the menu around will alter the
+        scroll position to keep the menu items "in place", i.e. at the same monitor
+        position they would have been without resizing.
+        In practice, this behavior is only useful for combobox popups or option
+        menus and cannot be used to simply confine a menu to monitor boundaries
+        (in which case the scroll offset shouldn't be changed).
 @user_data: the data supplied by the user in the gtk_menu_popup() @data
 parameter.